.\" Copyright (c) LibCheck, 2001-2020.
.\" 
.\" Permission is granted to copy, distribute and/or
.\" modify this document under the terms of the GNU
.\" Free Documentation License, Version 1.3 or any later
.\" version published by the Free Software Foundation; with
.\" no Invariant Sections, no Front-Cover Texts, and no
.\" Back-Cover Texts.  A copy of the license is included in
.\" the section entitled "GNU Free Documentation License".
.\"
.TH "suite_create" "3" "" "@PROJECT_VERSION@" "LibCheck"
.SH "PROLOG"
This manual page is part of the Check Programmer's Manual.
Additional information may be found at the Check Library
home page, at https://libcheck.github.io/check/.
.SH "NAME"
suite_create
\(em create test case container object
.SH "SYNOPSIS"
.LP
.nf
#include <check.h>
.P
Suite* suite_create(const char *name);
.SH "DESCRIPTION"
The
\fIsuite_create\fR()
function returns a pointer to a heap-allocated test suite
object.
.SH "RETURN VALUE"
Upon successful completion, the
\fIsuite_create\fR()
function returns a pointer containing the address of the
heap-allocated test suite object. Otherwise, the function
prints an error message to standard error indicating that
something went wrong, and then returns a NULL pointer.
